home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / HAMRADIO / SIMPTR20.ZIP / SIMP.DOC < prev    next >
Text File  |  1993-10-27  |  53KB  |  1,412 lines

  1.         
  2.         
  3.         
  4.         
  5.           SimpTerm - A Simple Amateur Radio
  6.         
  7.         
  8.                     Communications Program
  9.         
  10.         
  11.         
  12.                                   Jim Lynch
  13.         
  14.         
  15.                               October 27, 1993
  16.         
  17.         
  18.         
  19.         Contents
  20.         
  21.         
  22.         1  Introduction                                               2
  23.         
  24.         
  25.         2  Quick start                                                3
  26.         
  27.         
  28.         3  Display description                                        4
  29.            3.1  Receive window  : : : : : : : : : : : : : : : : : : : 4
  30.            3.2  Status line : : : : : : : : : : : : : : : : : : : : : 4
  31.            3.3  Transmit window  : : : : : : : : : : : : : : : : : :  4
  32.         
  33.         
  34.         4  The Initialization file                                    5
  35.            4.1  Keyboard assignments  : : : : : : : : : : : : : : : : 5
  36.                 4.1.1  Keyboard macros : : : : : : : : : : : : : : :  5
  37.                 4.1.2  Assigning files to function keys  : : : : : :  7
  38.                 4.1.3  Assigning functions to function keys  : : : :  7
  39.            4.2  Definition variables  : : : : : : : : : : : : : : : :10
  40.            4.3  Color Configuration   : : : : : : : : : : : : : : : :18
  41.            4.4  Command line options  : : : : : : : : : : : : : : : :18
  42.         
  43.         
  44.         5  Station logbook                                           19
  45.         
  46.         
  47.         6  Selective calling feature                                 20
  48.         
  49.         
  50.         7  License                                                   21
  51.         
  52.         
  53.         8  Trouble shooting                                          21
  54.         
  55.         
  56.         9  Error messages                                            21
  57.         
  58.         
  59.         10 Final notes                                               23
  60.         
  61.         
  62.         
  63.                                         1
  64.  
  65.         
  66.         
  67.         
  68.         11 Bugs                                                      23
  69.         
  70.         
  71.         12 Futures                                                   23
  72.         
  73.         
  74.         
  75.         1    Introduction
  76.         
  77.         
  78.         SimpTerm is a simple terminal program designed to be used with
  79.         almost any tnc or tu on the market. Features of SimpTerm are:
  80.         
  81.         
  82.            o Split window operation.
  83.         
  84.            o Macro key definitions.
  85.         
  86.            o User customizable Help screen
  87.         
  88.            o Most of the non-ascii keys can be used as function keys
  89.         
  90.            o Optional scroll back feature on the receive window and trans-
  91.              mit windows
  92.         
  93.            o Simple status display in the middle of the screen
  94.         
  95.            o Capturing of data to a disk file
  96.         
  97.            o Access DOS commands without dropping communications
  98.              connection
  99.         
  100.            o Control of the com port definitions from command line, init
  101.              file and keyboard.
  102.         
  103.            o Works on 8088 as well as 80486 and everything in-between.
  104.         
  105.            o Status line
  106.         
  107.            o Small enough to work well on resource tight platforms, like
  108.              laptops.
  109.         
  110.            o Selcal functions, limited unattended operation.
  111.         
  112.            o Times can be in GMT or local time.
  113.         
  114.            o A station logging function.
  115.         
  116.            o User selectable color scheme
  117.         
  118.            o Function keys and control keys can be assigned to a macro
  119.              string, cause a file to be uploaded or call a function within
  120.              the program.
  121.         
  122.         
  123.         
  124.                                         2
  125.  
  126.         
  127.         
  128.         
  129.         There are loads of programs that are tailored to specific tnc's and
  130.         there are dozens of good terminal programs that can control any
  131.         tnc in a "dumb" (that's a technical term) manner. This program is
  132.         an attempt to provide the average ham with something in-between.
  133.         It has a lot of features, but not so many as to make use of the pro-
  134.         gram or the tnc hard.  It requires you to know the commands of
  135.         your tnc, but also gives you the flexibility that only direct commu-
  136.         nications with a tnc can provide.
  137.         
  138.         
  139.         Statistics:
  140.         
  141.         
  142.         
  143.         Author:   Jim Lynch
  144.         
  145.         Call: K4GVO
  146.         
  147.         Address:   128 Carrollwood Dr. Fayetteville, GA 30214
  148.         
  149.         internet address:   jwl@cray.com
  150.         
  151.         packet address:   k4gvo@wgabbs.ga.usa or check the white pages
  152.         
  153.            If you write, please enclose a sase.  If you don't I reserve the
  154.         right not to answer.
  155.         SimpTerm was developed with:
  156.         
  157.            o Turbo C 2.0
  158.         
  159.            o C/Windows Toolchest, from Mix Software
  160.         
  161.            It was developed on a Toshiba T1000SE, but runs on my 386sx
  162.         with a VGA color monitor just fine.
  163.         
  164.         
  165.         
  166.         2    Quick  start
  167.         
  168.         
  169.         Edit the simp.ini file and change all references from K0QWG to
  170.         your call. Make sure the line that starts with "COM" looks ok for
  171.         your setup. If you have any problems understanding that line, see
  172.         the discussion on the COM directive later in this document.
  173.            Now execute the program. You will see an intro screen followed
  174.         shortly by a message instructing you to hit any key.  Do so and
  175.         you should see the screen split into two windows with a status line
  176.         between them. If you press enter, you will should see the prompt
  177.         from your TNC appear in the top window.  If you don't, then a
  178.         number of things could be wrong. See the trouble shooting section
  179.         of the manual for additional help.
  180.         
  181.         
  182.         
  183.                                         3
  184.  
  185.         
  186.         
  187.         
  188.            Now press the F1 key.  You should see a new window appear
  189.         listing some of the function keys that are currently assigned to
  190.         functions and what those functions do. Press any key to close the
  191.         help window.  Press the F3 key.  You should have a screen that
  192.         displays small windows of different colors with a number assigned
  193.         to each. Also you should see a menu near the bottom center of the
  194.         screen.
  195.            The menu is used to change the colors of the receive, transmit,
  196.         status and logging screens.  See the section on configuration for
  197.         details.  Press ESC to return the normal display if you like the
  198.         default colors.
  199.            Enter your tnc commands as you would normally do with a
  200.         dumb terminal.  If you have the echo turned on, you will see the
  201.         commands as you type on both screens.
  202.            Take a look at the simp.ini file and read the section on the
  203.         initialization file details. You should be able to customize this file
  204.         fairly easily.
  205.         
  206.         
  207.         
  208.         3    Display  description
  209.         
  210.         
  211.         There are three displays on the main screen. These are the trans-
  212.         mit, receive and status windows.
  213.         
  214.         
  215.         
  216.         3.1    Receive window
  217.         
  218.         This is the top window. Data coming back from the RS-232 port
  219.         will be displayed here. That is usually the output from the other
  220.         station. If you have the echo turned on you will also see the com-
  221.         mands that you typed.
  222.         
  223.         
  224.         
  225.         3.2    Status line
  226.         
  227.         The screen is divided into two separate windows with a status line
  228.         between them.  This status line contains information about the
  229.         current configuration of SimpTerm, the status of the selcal features
  230.         and other interesting information.
  231.         
  232.         
  233.         
  234.         3.3    Transmit window
  235.         
  236.         This is the bottom window.  It displays what you are typing and
  237.         some of the error messages reported by SimpTerm.
  238.         
  239.         
  240.         
  241.                                         4
  242.  
  243.         
  244.         
  245.         
  246.         4    The  Initialization  file
  247.         
  248.         
  249.         The initialize file (init file) is used to load the keyboard macros,
  250.         assign keys to files,  specify initial com port settings,  specify a
  251.         "preload" file for customizing your tnc each time you start SimpTerm
  252.         and to define a number of other options. The default init file name
  253.         is simp.ini.  This file must be in the directory from which you
  254.         started SimpTerm.
  255.         
  256.         
  257.         
  258.         4.1    Keyboard assignments
  259.         
  260.         Keys can be assigned to macros, functions or be used to initiate
  261.         file uploads.
  262.            A full listing of the keys that can be assigned are described in
  263.         the keys.doc file found in this distribution. They take the form of:
  264.         
  265.         
  266.         KEY_{modifier_}keyname
  267.         
  268.         The modifier may or may not be necessary, hence the curly braces,
  269.         meaning the stuff inside the braces isn't necessary, but might be
  270.         important. The modifier is one of the following:
  271.         
  272.         
  273.         SHIFT    (or SHFT in one case) designates the key must be de-
  274.              pressed with the shift key held down.
  275.         
  276.         CTRL    designates the key must be depressed with the control key
  277.              held down.
  278.         
  279.         ALT   designates the key must be depressed with the alt key held
  280.              down.
  281.         
  282.         
  283.            A few examples of valid keys are:
  284.         
  285.            o KEY_ALT-X
  286.         
  287.            o KEY_CTRL_P
  288.         
  289.            o KEY_F10
  290.         
  291.            o KEY_SHFT_TAB (this is the only SHFT, the rest are SHIFT)
  292.         
  293.            o KEY_SHIFT_F4
  294.         
  295.         
  296.         4.1.1   Keyboard macros
  297.         
  298.         Keyboard macros are strings that can be assigned to many of the
  299.         keys on your keyboard. This lets you assign frequently used char-
  300.         acter strings to a single key to save keystrokes. For instance, you
  301.         
  302.         
  303.         
  304.                                         5
  305.  
  306.         
  307.         
  308.         
  309.         might want to assign your call to the F1 key and your name to the
  310.         F2 key and your QTH to the F3 key.  That way when you were
  311.         talking to someone (with your fingers, that is) you would just type
  312.         "Hi, this is <F1>, <F2> in <F3>" and your computer would fill
  313.         in the right stuff. <F1> in the above example means that you hit
  314.         the F1 key, not that you typed the string "<F1>". Bear with me
  315.         you old timers, I want to make sure the newcomers don't give up
  316.         on us.
  317.            To define a macro you need to place the key name (yes, it must
  318.         be in upper case) in column one, followed by a space, followed by
  319.         the macro replacement string.
  320.         A simple example based on the earlier discussion would be:
  321.         
  322.         
  323.            o KEY_F1 K4GVO
  324.         
  325.            o KEY_F2 Jim
  326.         
  327.            o KEY_F3 Fayetteville, GA
  328.         
  329.         
  330.         Now when you punch <F1> <F2> <F3>
  331.         
  332.         K4GVO JIM Fayetteville, GA
  333.         
  334.         will get sent to the tnc.  I hope you were connected to someone,
  335.         'cause sending that garbage to the tnc in command mode won't be
  336.         very interesting.
  337.            The maximum length of a string that can be assigned to a key
  338.         is 511 characters.  You can continue the string on the next line
  339.         by placing a backslash (\) character at the very end of a line and
  340.         continuing with the definition on the next line.  Be careful not to
  341.         add a space after the \ because you won't be able to see it and the
  342.         program will think the next line is a new macro definition.  Note
  343.         that there will be no line breaks sent at the end of the line.
  344.         
  345.         
  346.            Example:
  347.         
  348.         
  349.         
  350.         KEY_ALT_C cq cq cq cq cq cq de k4gvo $"Backslash$
  351.         cq cq cq cq cq cq de k4gvo $"Backslash$
  352.         cq cq cq de k4gvo k
  353.         
  354.            This is an example of a complete definition. Note that the first
  355.         two lines have the backslash but the last one doesn't. This would
  356.         be ok for a cw call, but you probably want to be able to insert a
  357.         new line occasionally for rtty, amtor or packet work.
  358.         
  359.         
  360.         
  361.                                         6
  362.  
  363.         
  364.         
  365.         
  366.            You can insert any control character, including a carriage return
  367.         (that is what you normally send when you hit the enter key). Let's
  368.         try the above example with the addition of a carriage return.
  369.         
  370.         
  371.         Example:
  372.         
  373.         KEY_ALT_C cq cq cq cq cq cq de k4gvo^M$"Backslash$
  374.         cq cq cq cq cq cq de k4gvo^M$"Backslash$
  375.         cq cq cq de k4gvo k^M
  376.         
  377.         Now we have a reasonably constructed macro that won't offend the
  378.         station on the other end.
  379.            A control character is formed by preceding a letter with a caret
  380.         as shown above.  The control characters ctrl-a through ctrl-z are
  381.         formed as ^A through ^Z. If you want to include the caret as a
  382.         character to be send, use a double caret (^^).  Since there is no
  383.         such thing as a control-caret, the program will know to send a single
  384.         caret.  You can also specify other special characters and strings.
  385.         See the section on selective call reply strings for an expanded set
  386.         of options within the macro string.
  387.         
  388.         
  389.         4.1.2   Assigning files to function keys
  390.         
  391.         A function key can be assigned to a file by preceding the key name
  392.         with a ampersand (@). The name of the file follows the key name.
  393.         Hence:
  394.         
  395.         
  396.         @KEY_ALT_U mydefs.txt
  397.         @KEY_HOME c:$"Backslash$bob$"Backslash$mydefs.txt
  398.         
  399.         
  400.         are valid definitions. When the specified key is depressed, the file
  401.         is uploaded to the tnc. This means that the contents of the file are
  402.         sent to the tnc.  This is handy for defining a set of parameters to
  403.         customize your tnc for a specific mode of operation. You could use
  404.         the macros to do this, but they are limited to only 511 characters.
  405.         Another use for this is the "brag tape" (the word tape left over from
  406.         when we used paper tape on the old *eletype machines). You could
  407.         put a description of your station, location, personal information on
  408.         a file and by hitting a single key, you can send it to the other
  409.         station.
  410.         
  411.         
  412.         4.1.3   Assigning functions to function keys
  413.         
  414.         That sounds like a redundant statement doesn't it? It's not really.
  415.         There are six functions available in version 1.0 that can be assigned
  416.         to function keys. These are:
  417.         
  418.         
  419.         
  420.                                         7
  421.  
  422.         
  423.         
  424.         
  425.           quit        exit the program. Not a bad function to have.
  426.         
  427.           togcap      toggle logging of the incoming data.
  428.         
  429.           help        display the help screen
  430.         
  431.           dos         jump to dos
  432.         
  433.           status      print status of selcal
  434.         
  435.           togsel      toggle looking for selcal strings
  436.         
  437.           logit       brings up a data entry form for the station log
  438.         
  439.           config      configure the colors of the various parts of the
  440.                       screen
  441.         
  442.           reset       reset the communications port
  443.         
  444.           rforward    scroll the receive window forward one page
  445.         
  446.           xforward    scroll the transmit window forward one page
  447.         
  448.           rforward1   scroll the receive window forward one line
  449.         
  450.           xforward1   scroll the transmit window forward one line
  451.         
  452.           rback       scroll the receive window back one page
  453.         
  454.           xback       scroll the transmit window back one page
  455.         
  456.           rback1      scroll the receive window back one line
  457.         
  458.           xback1      scroll the transmit window back one line
  459.         
  460.           baudup      increment the communications baud rate
  461.         
  462.           bauddown    decrement the communications baud rate
  463.         
  464.           rlarger     make the receive window one line larger
  465.         
  466.           rsmaller    make the receive window one line smaller
  467.         
  468.           macro       assign a macro to a key on the fly
  469.         
  470.           upload      upload a file, prompts for name
  471.         
  472.           confcom     bring up a menu for com parameter selection
  473.         
  474.         
  475.            The togcap function will either ask for the name of a capture
  476.         file to start saving data to or close that file if capturing had already
  477.         been started by a previous call to togcap. The default capture file
  478.         name is simp.cap. You may override that name by typing in a new
  479.         name over top of the simp.cap entry. While you are capturing, the
  480.         name of the capture file is displayed on the status line. When you
  481.         are not capturing, the status lines displays "Capture off".
  482.            The help function is a rather simple one. It just opens a window
  483.         on the screen and dumps the contents of the help file into the
  484.         window.  If the help file is too long, the top part of the screen is
  485.         
  486.         
  487.         
  488.                                         8
  489.  
  490.         
  491.         
  492.         
  493.         scrolled off into never never land. Using a text editor of your choice
  494.         you may edit this file as you see fit. The default help file is named
  495.         simp.hlp, but you can tell SimpTerm to use another file via the
  496.         HELP customization option in the init file. See the init file section
  497.         for details.
  498.            The dos function brings up a second copy of the command
  499.         processor.  This allows you to execute commands just as if you
  500.         had exited the program, but the program is still in memory and
  501.         waiting for you to finish. After you have finished with dos and want
  502.         to return to SimpTerm, just enter "exit". That will bring you back
  503.         to SimpTerm where you left off.  The communications buffer can
  504.         hold 2048 characters. That is about one screenful. If you stay away
  505.         too long, you may lose data. Be careful.
  506.         
  507.         
  508.            There are 8 scrolling functions. These are:
  509.         
  510.         
  511.         rforward, rforward1, rback, rback1, xforward, xforward1,
  512.         xback xback1
  513.         
  514.         The rforward and xforward functions cause the receive or trans-
  515.         mit window to scroll forward one page. The rforward1 and xfor-
  516.         ward1 functions cause the receive or transmit screens to scroll
  517.         forward one line.
  518.            The rback, rback1, xback and xback1 functions perform the
  519.         reverse operations respectively.
  520.            The baudup function will increase the baud rate one step. It
  521.         will cycle through the following baud rates, 300, 1200 2400, 4800
  522.         and 9600.  If you must use other rates, you will have to set them
  523.         via the COM input line in the init file.
  524.            The bauddown function will decrease the baud rate one step.
  525.         It will cycle through the same baud rates as described in the pre-
  526.         vious paragraph.
  527.            The rsmaller function will reduce the size of the receive window
  528.         by one line. This has the effect of moving the status line up one line
  529.         and increasing the size of the transmit window by one line.  The
  530.         rlarger function has the reverse effect. You cannot reduce either
  531.         window below 3 lines high.
  532.            The macro function is used to define a macro and assign it to
  533.         a key without leaving the program. You are first asked to press a
  534.         key. This is the key to which the macro will be defined. I suggest
  535.         you don't use a printable key, like a letter or a number, but that is
  536.         a legal key. You can use this to assign macros to keys that aren't
  537.         on the list of valid keys as long as the program recognizes that a
  538.         key has been pressed.
  539.         
  540.         
  541.         
  542.                                         9
  543.  
  544.         
  545.         
  546.         
  547.            The upload function lets you upload any file to the tnc. You
  548.         will be prompted for the file name.
  549.            The confcom function brings up a menu screen with radio
  550.         buttons to use to configure the com port.  You may find it isn't
  551.         worth much unless you have a mouse.
  552.         
  553.         
  554.            To assign a function key to one of these functions, precede the
  555.         definition by an exclamation point (!).
  556.         
  557.         
  558.         E. g.
  559.         
  560.         !KEY_ALT_X quit
  561.         !KEY_CTRL_L togcap
  562.         !KEY_ALT_H help
  563.         !KEY_F10 togsel
  564.         !KEY_ALT_S status
  565.         !KEY_ALT_J dos (Jump to dos)
  566.         
  567.         
  568.         
  569.            The simp.ini file included in the distribution assigns the page-
  570.         down and pageup keys to the rforward and rback functions respec-
  571.         tively. Also the up arrow and down arrow keys are assigned to the
  572.         rback1 and rforward1 functions.
  573.            Just in case you don't have the quit function assigned to a key,
  574.         the END key has been permanently bound to the quit function.
  575.         So you don't accidently hit it and drop out of the program, the
  576.         end key must be pressed twice in succession to end the program.
  577.         You can't assign the KEY_END key to anything else. The program
  578.         won't complain if you try, but it just won't work the way you think
  579.         it should.
  580.            There are a few other keys that are special.
  581.         
  582.         
  583.         KEY_BKSP and KEY_CTRL_H
  584.         
  585.         are intra-line edit functions and cannot be reassigned.
  586.         
  587.         
  588.         KEY_ENTER
  589.         
  590.         can't be reassigned either, obviously.
  591.         
  592.         
  593.         
  594.         4.2    Definition variables
  595.         
  596.         You can set a number of configuration options by defining variables
  597.         in the initialization file. This section discusses them.
  598.         
  599.         
  600.         Comment lines
  601.         
  602.         
  603.         
  604.                                        10
  605.  
  606.         
  607.         
  608.         
  609.         If the program finds a # (pound) sign in the first column of a line
  610.         in the init file, it will stop processing that line. This is a way that
  611.         you can comment your init file. Also any of the options described
  612.         below that have a fixed format will allow comments following all
  613.         of the permitted arguments. If an option has a variable number of
  614.         arguments, you can't put a comment on that line.
  615.         E. g.
  616.         
  617.         # this is a valid comment
  618.         mid 15 # this is ok also.
  619.         
  620.         COM port definition option
  621.         
  622.         The COM port parameters must be set to match your tnc. If you
  623.         don't know what speed, word size, etc.  that your tnc is using,
  624.         consult the manual that came with the tnc.  A lot of the packet
  625.         tnc's around have an autobaud detect feature.  When you power
  626.         them up for the first time they wait until you type an asterisk and
  627.         then they can determine the operating parameters you are using.
  628.            If you have both a COM option line in your init file and a
  629.         command line com option then the command line option will be
  630.         used. This way the command line can be used to override the init
  631.         file if desired.
  632.         If you don't tell SimpTerm what parameters to use it will default
  633.         to:
  634.         
  635.         
  636.         use COM1
  637.         2400 bits per second (baud)
  638.         8 data bits
  639.         No parity
  640.         1 stop bit.
  641.         
  642.         
  643.         If you insert the line,
  644.         COM1 4800,7,E,1
  645.         it will change the COM1 port to work with:
  646.         
  647.         
  648.         4800 bits per second (baud)
  649.         7 data bits
  650.         even parity
  651.         1 stop bit.
  652.         
  653.         
  654.            See the section on command line options for the full set of op-
  655.         tions for each of these parameter fields.  There must be exactly 4
  656.         fields.  The COM? line requires a SPACE immediately after the
  657.         COM? field.  The command line version of this command uses a
  658.         COMMA between these fields. Try not to get these confused. Of
  659.         
  660.         
  661.         
  662.                                        11
  663.  
  664.         
  665.         
  666.         
  667.         course, if you have your tnc connected to one of the other com
  668.         ports(like 3), you will want to use a line that looks like:
  669.         
  670.         
  671.         COM3 9600,8,N,1
  672.         
  673.         instead.
  674.         
  675.         
  676.         HELP file specification
  677.         
  678.         The default HELP file name may be overridden by including the
  679.         HELP configuration line in the init file.  This is simply the key
  680.         word HELP followed by a file name.
  681.         
  682.         
  683.         MID screen layout
  684.         
  685.         One of the feature of SimpTerm is that is has a split screen. This
  686.         allows you to have a "transmit" window that displays what you
  687.         are typing along with informative messages from the program and
  688.         a "receive" window that displays the data coming back from your
  689.         tnc. The size of the windows is determined by the mid command
  690.         line option. This value should be between 4 and 20. A value of 15
  691.         will give you a 15 line transmit window and a 9 line receive window.
  692.         If you specify a value for MID out side of this range a default will
  693.         be chosen for you.
  694.         
  695.         
  696.         PRELOAD file specification
  697.         
  698.         There is an option available that lets you send a file to the tnc be-
  699.         fore control is turned over to you at the keyboard. The PRELOAD
  700.         option line specifies the name of this file. It follows the same form
  701.         as the HELP file spec.  This option may be used to force certain
  702.         operating parameters when starting up SimpTerm. One use of this
  703.         feature would be to keep different init files each with a different
  704.         PRELOAD file. One PRELOAD file might set the tnc to work hf,
  705.         while another might specify vhf. If you have two hams that use the
  706.         same equipment, you might want each to have his/her own custom
  707.         PRELOAD file to change, at least, the call letters.
  708.         
  709.         
  710.         SELFILE file specification
  711.         
  712.         This line specifies the name of the file that will receive the selcal
  713.         messages.  The default is "simp.sel".  If you want to specify a
  714.         different file name and/or drive specification put the SELFILE line
  715.         in the init file.
  716.         E. g.
  717.         SELFILE a:\messages
  718.            The messages that are stored in this file are appended to any
  719.         
  720.         
  721.         
  722.                                        12
  723.  
  724.         
  725.         
  726.         
  727.         previous messages, so you will not lose any previously recorded
  728.         messages but you might want to look at the size of this file occa-
  729.         sionally so you don't run yourself out of disk space.
  730.         
  731.         
  732.         GMT time specification line
  733.         
  734.         If the program finds this line in the init file, it will attempt to
  735.         display the times in GMT. Since the time function is only used
  736.         with selective calling functions, non-selcal users can ignore this
  737.         option. In order to make these functions work right, you must set
  738.         your dos clock to your local time and set the environment variable
  739.         TZ to indicate your local time zone relative to GMT. The format
  740.         of the TZ variable is:
  741.         TZ=zzz[+/-]d[d][lll]
  742.         Where:
  743.         
  744.         zzz is a 3 character string representing the name of the current
  745.              time zone. E. g. CST or EST.
  746.         
  747.         [+/-  d[d]] is a optionally signed number with 1 or 2 digits.  This
  748.              number is the local time zone's difference from GMT in hours.
  749.              Positive numbers adjust westward from GMT
  750.         
  751.         lllis an optional 3 character field that represents the local time
  752.              zone daylight savings time. E. g. PDT Environment variables
  753.              are either set in your autoexec.bat file, or can manually be
  754.              typed in before you execute the program. Consult your DOS
  755.              manual for more information.
  756.         
  757.         
  758.         
  759.         Examples (DOS command line):
  760.         
  761.         
  762.         SET TZ=EST5EDT          (New York)
  763.         
  764.         SET TZ=CST6       (Indiana, they don't used daylight time, do they?)
  765.         
  766.         SET TZ=PST8PDT          (Los Angeles)
  767.         
  768.         
  769.         
  770.            Because of the "new" rules surrounding daylight time,  you
  771.         might find that the time is an hour off during some parts of the
  772.         year.  You might want to keep your dos clock in GMT, or adjust
  773.         your TZ environment to give you the correct GMT value.
  774.         
  775.         
  776.         SELREPLY reply line
  777.         
  778.         When a remote station sends you a specific select, i. e. a request for
  779.         you to start recording an incoming message, it will expect you to
  780.         
  781.         
  782.         
  783.                                        13
  784.  
  785.         
  786.         
  787.         
  788.         reply immediately with a message so it doesn't waste time sending
  789.         you a message if your equipment isn't monitoring.  This option
  790.         specifies the reply that you will give in response to the select.
  791.            The format of this reply line can contain ascii characters, control
  792.         characters, or special formatting characters.  The ascii characters
  793.         are the normal printable characters (or subset in the case of bau-
  794.         dot or amtor). The control characters are formed by a commonly
  795.         used notation where the caret precedes a character to indicate the
  796.         control code should be sent and not the character itself.
  797.         E. g.
  798.         
  799.         ^m  carriage return (enter)
  800.         
  801.         ^j line feed
  802.         
  803.         ^d  Control-d
  804.         
  805.         ^@  Null (0)
  806.         
  807.         ^^  caret
  808.         
  809.            Some of the control characters can be specified via the C lan-
  810.         guage backslash escape notation. These are the only ones allowed.
  811.         
  812.         
  813.         \t tab
  814.         
  815.         \n linefeed (new line)
  816.         
  817.         \r return
  818.         
  819.         \\ backslash
  820.         
  821.         
  822.            Also included are a few time and date functions that can be
  823.         specified by a %c notation, where c is one of the following:
  824.         
  825.         
  826.         D  The date and time in the form dd-MMMyy hh:mm
  827.         
  828.         t The time in the form hh:mm
  829.         
  830.         d The date in the form dd-MMMyy
  831.         
  832.         
  833.         Where:
  834.         
  835.         dd  is the day of the week,
  836.         
  837.         MMM     is the 3 Character abbreviation of the month
  838.         
  839.         yy is the 2 digit year
  840.         
  841.         hh  is the hour
  842.         
  843.         
  844.         
  845.                                        14
  846.  
  847.         
  848.         
  849.         
  850.         mm   is the minute
  851.         
  852.         
  853.         
  854.         Example:
  855.            SELREPLY x\r^O^O^O^O^O^Ode K4GVO, %D\r^D
  856.            Using the PK-232, you can send the "letters" characters with
  857.         the control-O character, so to make sure that the other station
  858.         has gotten his transmitter shutoff, you might want to delay your
  859.         transmission a bit via this method.  The "x" character, followed
  860.         by the carriage return tells the PK-232 to start transmitting. The
  861.         ctrl-D at the end tells the PK-232 to stop transmitting and resume
  862.         receiving.
  863.         
  864.         
  865.         RSELCAL selective call string option
  866.         
  867.         This line specifies the selcal string(s) that you want to react to.
  868.         You may specify up to 5 strings.  The strings can be delimited
  869.         by spaces, commas or tabs.  The strings can NOT contain any of
  870.         these characters. Since these strings should probably contain your
  871.         call or your call and some trailing characters, this shouldn't be a
  872.         problem.  These strings ARE case sensitive.  That means that if
  873.         you are running in a mode that supports upper and lower case,
  874.         you had better put your selcal in both upper and lower case and
  875.         hope that the sending station doesn't send mixed case. All strings
  876.         identified from this set of strings by the program will be replied to
  877.         with the SELREPLY string.
  878.         
  879.         
  880.         Examples:
  881.         RSELCAL k4gvo K4GVO k4gvo-9 kd4rqn
  882.         
  883.         
  884.         ALLCAL selcal option
  885.         
  886.         
  887.         
  888.            This option specifies the set of strings that the program will
  889.         look for to start a "all call" recording. When the program finds a
  890.         string in this group, it starts recording a message without sending
  891.         a reply.  Other than that, it behaves in exactly the same manner
  892.         as the RSELCAL option.
  893.         
  894.         
  895.         Example: ALLCAL ANYONELISTENING TOALLOFYOU allcal
  896.            Note:  as far as I can determine the PK-232 doesn't transmit
  897.         the figures or letters characters (baudot) to the program so there
  898.         doesn't appear to be a way to specify the old (1967) all call of
  899.         LETTERS N LETTERS N LETTERS N LETTERS N, so there
  900.         must be a new convention, but I don't know what it is.
  901.         
  902.         
  903.         
  904.                                        15
  905.  
  906.         
  907.         
  908.         
  909.         ENDCALL selcal option
  910.         
  911.         Obviously there must be a way to tell the program to stop recording
  912.         a message and one of these ways is to send a stop string. This option
  913.         specifies a group of strings that will be used to stop the recording
  914.         of the incoming message.  This the format for these strings is the
  915.         same as the previous two.
  916.         Example:
  917.         
  918.         
  919.         ENDCAL NNNN nnnn ZCZC zczc
  920.         
  921.         
  922.         SELMAXT selcal time limit option
  923.         
  924.         So that the program doesn't record reams of garbage, a time limit
  925.         can be specified. This time limit is in seconds and will only record
  926.         for "n" seconds. If it hasn't received a ENDCAL string by then, it
  927.         will close the received file. A line will be placed in the file indicating
  928.         that the recording was terminated because of a timeout.
  929.         
  930.         
  931.         Examples:
  932.         SELMAXT 300 (record for 5 minutes, maximum)
  933.         SELMAXT 32000 (record for virtually forever)
  934.         SELMAXT 12 (record only very short messages!)
  935.         
  936.         
  937.         EXTEND time limit extension string
  938.         
  939.         Now it is nice to limit your messages to a specific time limit, but if
  940.         someone just has to get a long message to you, he(she) will have to
  941.         send it in chunks. He(she) might not know what you have set your
  942.         time limit to, so he might have to send it in a lot of little chunks to
  943.         be sure that he doesn't time out. In order to avoid that problem,
  944.         the EXTEND option can specify a string that the remote station
  945.         can send to you to tell you to set your time limit to a different
  946.         value. The format of the EXTEND option is:
  947.         EXTEND <string> <newtimelimit>
  948.         Where:
  949.         
  950.         string is a group of characters (not including space and tab)
  951.         
  952.         newtimelimit    is the absolute maximum that you want someone
  953.              to set your timelimit to.
  954.         
  955.         An example is in order. If you have the following in your init file,
  956.         EXTEND NEWTIMEX 600
  957.         and a remote station sends your selcal string and then (after wait-
  958.         ing for your reply) sends a line that looks like: NEWTIMEX 300^m
  959.         
  960.         
  961.         
  962.                                        16
  963.  
  964.         
  965.         
  966.         
  967.         (remember the ^m is an enter or end-of-line character) your pro-
  968.         gram will set your time limit to 300, giving the remote station the
  969.         opportunity to send you up to 5 minutes worth of data. If he(she)
  970.         had specified EXTEND NEWTX 4000, the program would limit
  971.         the time to 10 minutes, based on the absolute limit you placed on
  972.         the time of 600 seconds.
  973.            Of course, the other station should be aware of your extend
  974.         string.  If this string comes in while you are not recording a mes-
  975.         sage, it will be ignored.
  976.         
  977.         
  978.         FLATLOG
  979.         
  980.         Use this parameter by itself to indicate that you want the station
  981.         log to be kept in a "flat" file format. In this case, flat means that
  982.         the data is in fixed columns. This might be useful for someone that
  983.         wanted to process the log from a program and didn't want to deal
  984.         with the "comma delimited" format that is the default.
  985.         
  986.         
  987.         SNOW
  988.         
  989.         Some of the older CGA cards would produce snow on the screen
  990.         when direct video writes were done. If you see snow on your screen,
  991.         try to insert the snow directive in your simp.ini file.
  992.         
  993.         
  994.         BIOS
  995.         
  996.         If you have a "near compatible" PC and the display isn't func-
  997.         tioning correctly, try to use the bios method of writing data to
  998.         the screen. It is fairly slow, but if that is all you have, it's better
  999.         than nothing. Insert the bios directive in your simp.ini if you are
  1000.         still having trouble with snow. Don't have both active at the same
  1001.         time. Include either snow or bios; or don't put anything.
  1002.         
  1003.         
  1004.         NOMOUSE
  1005.         
  1006.         If you have a mouse, you will see a scrollbar to the right of the
  1007.         receiving (top) screen. If you find that having a mouse causes you
  1008.         problems, insert the nomouse directive to cause the program to
  1009.         treat you as if you didn't have a mouse.
  1010.         
  1011.         
  1012.         QUIET
  1013.         
  1014.         If you don't like the annoying startup screen telling you what you
  1015.         are running and who's sweat gave it to you, insert the quiet direc-
  1016.         tive in your startup file.
  1017.         
  1018.         
  1019.         DDMMYY
  1020.         
  1021.         
  1022.         
  1023.                                        17
  1024.  
  1025.         
  1026.         
  1027.         
  1028.         Just in case someone wants to use this program in Europe or wher-
  1029.         ever else they use the day-month-year format, instead of the month-
  1030.         day-year used here, they can put this directive in their startup
  1031.         file and the program will generate the date October 31,  1993,
  1032.         as 31/10/93.  But I have no idea why you would want to.  (Jim
  1033.         GRINS).
  1034.         
  1035.         
  1036.         YYMMDD
  1037.         
  1038.         This format is also included for completeness. It is left to the reader
  1039.         to determine what it means. (Hint: read the previous paragraph)
  1040.         
  1041.         
  1042.         LOGFILE
  1043.         
  1044.         This directive specifies the name of the station log. The default is
  1045.         station.log.
  1046.         Example: LOGFILE k4gvo.log
  1047.         
  1048.         
  1049.         
  1050.         4.3    Color Configuration
  1051.         
  1052.         You can select one of the items by moving the highlighted bar up
  1053.         and down with the up and down arrow keys.
  1054.         
  1055.         
  1056.         
  1057.         4.4    Command line options
  1058.         
  1059.         The SimpTerm command line looks like:
  1060.         simp -init initfile -mid number -com comparamstring -word -V -
  1061.         quiet
  1062.         Where:
  1063.         
  1064.         quiet tells the program not to display the introductory screen. See
  1065.              the QUIET directive for more details.
  1066.         
  1067.         word  causes displayed data in a window to wrap on a word boundry.
  1068.         
  1069.         V  display the version number.
  1070.         
  1071.         initfile is the name of a file to be used as the initialization file
  1072.              containing the key definitions and other customization pa-
  1073.              rameters. The default file name is "simp.ini".
  1074.         
  1075.         number   is the line number of the middle of the screen.  This is
  1076.              used to define the location of "split" between the transmit
  1077.              and receive windows. Default is 12. See discussion below.
  1078.         
  1079.         
  1080.         
  1081.                                        18
  1082.  
  1083.         
  1084.         
  1085.         
  1086.         comparamstring     is the communications port parameter string.
  1087.              This specification overrides the COM init file option.
  1088.         
  1089.              The comparamstring parameter is in the form:
  1090.         
  1091.         
  1092.              comn,baud,wordsize,parity,stopbits
  1093.         
  1094.         
  1095.              Where:
  1096.         
  1097.              comn   is the com port number, 1, 2, 3 or 4. This also can be
  1098.                   specified as COM1, COM2, COM3 or COM4.
  1099.         
  1100.              baud   is the baud rate. Must be one of, 300, 1200, 2400, 4800
  1101.                   or 9600.
  1102.         
  1103.              wordsize   is either 7 or 8.
  1104.         
  1105.              parity  is one of the following: N, O, E, M, S.
  1106.         
  1107.              stopbits  is one of: 1 or 2.
  1108.         
  1109.            The following settings are the most common. If you don't know
  1110.         for sure what to set them to, try these.
  1111.         
  1112.                  <comn>,<baud>,7,E,1
  1113.                  <comn>,<baud>,8,N,1
  1114.         
  1115.            and maybe
  1116.         
  1117.                  <comn>,<baud>,7,O,1
  1118.         
  1119.         The <comn> and <baud> depend on your computer hardware
  1120.         configuration and your tnc interface speed.
  1121.            You may use spaces instead of commas to separate the COM
  1122.         fields. If you do, you must enclose the entire field in quotes, such
  1123.         as:
  1124.         simp -com "COM1 4800 8 N 1"
  1125.         If you have both a COM option line in your init file and a command
  1126.         line com option then the command line option will be used. This
  1127.         way the command line can be used to override the init file if desired.
  1128.         
  1129.         
  1130.         
  1131.         5    Station  logbook
  1132.         
  1133.         
  1134.         The station logging screen allows you to enter a number of possibly
  1135.         helpful items.  The first two fields will be filled in for you as they
  1136.         are the current date and time.  The cursor will be positioned at
  1137.         the third field, but if you want to change the previous fields, just
  1138.         press the CTRL-TAB key. A list of the editing keys is available by
  1139.         pressing the F1 key while the logging data form is displayed. The
  1140.         fields and their sizes is as follows:
  1141.         
  1142.         
  1143.         
  1144.                                        19
  1145.  
  1146.         
  1147.         
  1148.         
  1149.         Field Name          Size           Starting position in log file
  1150.         DATE                  6               1
  1151.         TIME                  5               7
  1152.         CALL                 11             12
  1153.         NAME                 20             23
  1154.         QTH                  39             43
  1155.         MY RST                7             82
  1156.         HIS RST               5             89
  1157.         MODE                 10             94
  1158.         COMMENTS            48             104
  1159.         FREQUENCY            7             152
  1160.         POWER                 4             159
  1161.         QSL                   4             163
  1162.         OTHER                12             167
  1163.         ENDTIME               4             179
  1164.         
  1165.            Which looks like about a 182 character record in the flatfile
  1166.         mode. I hope all of these fields are self-explanatory. The OTHER
  1167.         field is just an additional field that can be used to put things I
  1168.         didn't think of.
  1169.            If you elect not to use the flatfile mode your file will be in this
  1170.         format
  1171.         "103193","0532","k4gvo","Jim","Fayetteville, GA",
  1172.         "599","599","","10.109","100","","","","0650"
  1173.            Of course, it will be all on one line.  This format is called
  1174.         "comma delimited" by *base and others of its ilk.  This format
  1175.         may be imported to many of the database managers and spread-
  1176.         sheets available on DOS. If you don't like the layout, drop me a
  1177.         note.
  1178.         
  1179.         
  1180.         
  1181.         6    Selective  calling  feature
  1182.         
  1183.         
  1184.         Here is part of a typical init file that will support the selective
  1185.         calling feature.
  1186.         
  1187.         !KEY_F10 togsel
  1188.         RSELCAL k4gvo K4GVO W4LYBZW k4gvozw
  1189.         ENDCAL ZCZC zczc NNNN nnnn
  1190.         ALLCAL ALLSTAT
  1191.         SELMAXT 240 seconds
  1192.         EXTEND MXLEN 600
  1193.         SELREPLY $"Backslash$rx$"Backslash$r^o^o^o^o^o^ode k4gvo %D ^m^d
  1194.         
  1195.            If, in the body of a message being recorded, the string "MXLEN"
  1196.         is found, the time limit will be bumped up to 10 minutes.  Note
  1197.         
  1198.         
  1199.         
  1200.                                        20
  1201.  
  1202.         
  1203.         
  1204.         
  1205.         that the "seconds" field on the SELMAXT option line is really a
  1206.         comment and not a specification.  The following line WON'T set
  1207.         the time to 2 minutes.
  1208.            SELMAXT 2 minutes
  1209.         
  1210.         
  1211.         
  1212.         7    License
  1213.         
  1214.         
  1215.         I'm not going to bother with the usual nonsense about responsibil-
  1216.         ity and guarantees. If you're foolish enough to use a free package
  1217.         with something that you think is critical enough that you might
  1218.         be tempted to sue someone if it screws up, you deserve what you
  1219.         might get.  CAVEAT EMPTOR! I hope I spelled that right.  My
  1220.         last Latin course was before my first FORTRAN II course. Am I
  1221.         telling my age?
  1222.            I guess I didn't mention that this program is almost free. Might
  1223.         even be freeware, but since freeware is a registered trademark, I
  1224.         understand, I won't call it that. If you use this program and feel it
  1225.         is of any value, please drop something in the next Salvation Army
  1226.         kettle you see.  If that activity offends you for any reason, please
  1227.         just do something nice for someone that you wouldn't normally do.
  1228.         Like buy your secretary lunch the next time she screws up royally
  1229.         instead of reaming her out.
  1230.            You can use it, change it, abuse it, distribute it, charge for it
  1231.         or most anything else you want to do with it, except if you charge
  1232.         more than a reasonable copying charge for it, you must tell whoever
  1233.         you sold it to that they could have gotten it for nothing if they had
  1234.         just looked around. You may distribute it in any form, as long as
  1235.         this file is included in its original form. You may add as many files
  1236.         as you wish.
  1237.            If you want source, drop me a note and we'll discuss it.  I'll
  1238.         probably eventually turn it out into the public domain, but I'd be
  1239.         too embarrassed to do so with it now.
  1240.         
  1241.         
  1242.         
  1243.         8    Trouble  shooting
  1244.         
  1245.         
  1246.         This section hasn't been written yet.
  1247.         
  1248.         
  1249.         
  1250.         9    Error  messages
  1251.         
  1252.         
  1253.         I hope they are few and perfectly understandable. I haven't com-
  1254.         piled a complete list, but here are a few you may encounter during
  1255.         the initialization phase.
  1256.         
  1257.         
  1258.         
  1259.                                        21
  1260.  
  1261.         
  1262.         
  1263.         
  1264.         HELP line has no file name
  1265.         
  1266.         
  1267.         The HELP line must have a valid file name as the first parameter.
  1268.         
  1269.         
  1270.         LOGFILE line has no file name
  1271.         
  1272.         
  1273.         The LOGFILE line must have a valid file name as the first param-
  1274.         eter.
  1275.         
  1276.         
  1277.         PRELOAD has no file name
  1278.         
  1279.         
  1280.         The PRELOAD line must have a valid file name as the first pa-
  1281.         rameter.
  1282.         
  1283.         
  1284.         MID has no value
  1285.         
  1286.         
  1287.         The MID line must have a valid non-zero, non-blank value as the
  1288.         first parameter.
  1289.         
  1290.         
  1291.         Key table corrupt
  1292.         
  1293.         
  1294.         This is an internal error, it should never appear unless memory
  1295.         gets overwritten.
  1296.         
  1297.         
  1298.         Line nn, Invalid key name <keyname>
  1299.         
  1300.         
  1301.         SimpTerm can't identify the key name on the line, number nn.
  1302.         Check your spelling.
  1303.         
  1304.         
  1305.         Malloc failed
  1306.         
  1307.         
  1308.         SimpTerm ran out of memory.
  1309.         
  1310.         
  1311.         Number of lines, nnn exceeds max, mmm
  1312.         
  1313.         
  1314.         The maximum number of continuation lines has been exceeded.
  1315.         
  1316.         
  1317.         Port definition in error, line nnn
  1318.         
  1319.         
  1320.         There is something wrong with the COM port definition on line
  1321.         nnn. Be sure it looks like the examples given above.
  1322.         
  1323.         
  1324.         Port init failed nn
  1325.         
  1326.         
  1327.         The attempt to initialize the com port failed with an error of nn.
  1328.         
  1329.         
  1330.         
  1331.                                        22
  1332.  
  1333.         
  1334.         
  1335.         
  1336.         10     Final  notes
  1337.         
  1338.         
  1339.         I hope that you find this program easy and enjoyable to use.  I
  1340.         wrote it while I was traveling with a T1000SE (8086) laptop (no
  1341.         hard drive), a PK-232 and a IC-730.  I didn't really like to use a
  1342.         simple terminal program and felt the big gun programs, just were
  1343.         too clumsy for portable use.  I've made a few enhancements to
  1344.         that original program and hope that you will find it acceptable. I
  1345.         suspect that you aren't going to find a cheaper product.
  1346.            This manual was typeset with LaTEX. I will be offering a hard-
  1347.         copy of this manual on 8.5 x 11, 3 hole punched paper ready for
  1348.         your 3 ring binder in the near future at what amounts to repro-
  1349.         duction and mailing costs. If you are interested please drop me a
  1350.         note with a sase.
  1351.            If you like SimpTerm. Tell others about it. If you don't like it,
  1352.         please tell me why. If you don't like it and tell others that it isn't
  1353.         any good, then we all lose. You lose, 'cause I just might be able to
  1354.         make it what you wanted, if I only knew, others lose 'cause they
  1355.         might find something in it for them that you weren't interested in
  1356.         and I lose, 'cause my feelings have been hurt, so PLEASE if you
  1357.         want to complain, fire it my direction. I can't promise I can make
  1358.         it your personal rose garden, but I will try to fix any problems or
  1359.         deficiencies that might show up.
  1360.            Oh, I know the documentation isn't up to snuff, but it's better
  1361.         than not getting it out at all. I sure had fun with the spell checker.
  1362.         It wanted to make rtty into ratty and amtor into actor. Wonder if
  1363.         it knows something I don't?
  1364.         
  1365.         
  1366.         
  1367.         11     Bugs
  1368.         
  1369.         
  1370.         I think I have fixed all that have been reported.
  1371.            The enhanced keyboards aren't supported yet.  F11 and F12
  1372.         don't work.
  1373.         
  1374.         
  1375.         
  1376.         12     Futures
  1377.         
  1378.         
  1379.         
  1380.         Clean up the code so I'm not embarrassed to distribute it.
  1381.         
  1382.         
  1383.         It does not support the enhanced keyboard.
  1384.         
  1385.         
  1386.         I'd like to add a more robust station logging function or maybe
  1387.         multitask with the command processor so one could run their fa-
  1388.         
  1389.         
  1390.         
  1391.                                        23
  1392.  
  1393.         
  1394.         
  1395.         
  1396.         vorite logging program at the same time with out having to use
  1397.         DV or something similar.
  1398.         
  1399.         
  1400.         I plan on implementing a user-configurable log format, where the
  1401.         user can describe the number, names and sizes of the log data.  I
  1402.         also am thinking about supporting .dbf file structures in addition
  1403.         to the flatfile and comma delimited.
  1404.         
  1405.         
  1406.         Alas, there is no index in this document. /LaTex does have support
  1407.         for an index, but I haven't gotten around to it yet.
  1408.         
  1409.         
  1410.         
  1411.                                        24
  1412.